Chuyển tới nội dung chính

Chuyển đổi

Chuyển đổi một số tiền từ một loại tiền tệ sang loại khác sử dụng tỷ giá hiện tại cho Merchant yêu cầu. Chuyển đổi sử dụng tỷ giá tương tự như API Lấy tỷ giá FX, trong giai đoạn hiệu lực của báo giá đó.

Hướng (và do đó tỷ giá nào được áp dụng) được suy ra từ thứ tự của from_currencyto_currency:

  • Chuyển đổi ngoại tệ → VND (khách hàng bán ngoại tệ) áp dụng tỷ giá bid.
  • Chuyển đổi VND → ngoại tệ (khách hàng mua ngoại tệ) áp dụng tỷ giá ask.

Phía được áp dụng được trả về trong rate_type, và response mang cùng quote_code để báo giá có thể được đối chiếu (và ở giai đoạn sau, khóa lại).

Đường dẫn

  • URL: /cb-core/api/v1/fx/convert
  • Method: POST
  • Mô tả: Chuyển đổi số tiền giữa hai loại tiền tệ sử dụng tỷ giá hiện tại.

Request

Bảng Request

Tham sốLoại dữ liệuBắt buộcMô tả
request_idstring(50)Mã duy nhất định danh request. Định dạng gợi ý: MerchantCode + BK + YYYYMMDD + UniqueId
request_timestring(19)Thời gian Merchant gửi request. Định dạng: YYYY-MM-DD HH:MM:SS
merchant_codestring(20)Mã merchant được Baokim cung cấp trước khi tích hợp
from_currencystring(10)Loại tiền tệ được chuyển đổi từ (ví dụ USD). Chỉ cho phép một mã tiền tệ
to_currencystring(10)Loại tiền tệ được chuyển đổi thành (ví dụ VND). Chỉ cho phép một mã tiền tệ
amountdecimal(18,2)Số tiền, tính bằng from_currency, để chuyển đổi

Ví dụ Request

{
"request_id": "MERCHANT1234BK202606053",
"request_time": "2026-06-05 10:15:30",
"merchant_code": "MERCHANT1234",
"from_currency": "USD",
"to_currency": "VND",
"amount": 1000.00
}

Response

Bảng Response

Tham sốLoại dữ liệuBắt buộcMô tả
response_codeint(4)Mã kết quả từ Baokim, theo bảng Mã lỗi
response_messagestring(200)Mô tả mã kết quả
merchant_codestring(20)Mã merchant được Baokim cung cấp trước khi tích hợp
dataObjectKết quả chuyển đổi

Cấu trúc Object Data (bên trong data)

Tham sốLoại dữ liệuMô tả
currency_pairstring(10)Cặp tiền tệ được sử dụng cho chuyển đổi, ở định dạng BASE/QUOTE (ví dụ USD/VND)
from_currencystring(10)Loại tiền tệ được chuyển đổi từ
to_currencystring(10)Loại tiền tệ được chuyển đổi thành
amountdecimal(18,2)Số tiền đầu vào, tính bằng from_currency
converted_amountdecimal(18,2)Số tiền kết quả, tính bằng to_currency
ratedecimal(18,4)Tỷ giá áp dụng (VND trên 1 đơn vị ngoại tệ)
rate_typestring(3)Phía được áp dụng: bid hoặc ask
quote_codestring(50)Mã báo giá cho tỷ giá này. Dùng để đối chiếu và dành cho khóa tỷ giá
last_updatedstring(19)Thời gian tỷ giá được làm mới lần cuối. Định dạng: YYYY-MM-DD HH:MM:SS
valid_untilstring(19)Thời gian cho đến khi báo giá còn hiệu lực. Có thể null ở giai đoạn hiện tại

Ví dụ Response

{
"response_code": 200,
"response_message": "Thành công",
"merchant_code": "MERCHANT1234",
"data": {
"currency_pair": "USD/VND",
"from_currency": "USD",
"to_currency": "VND",
"amount": 1000.00,
"converted_amount": 26450000.00,
"rate": 26450.0000,
"rate_type": "bid",
"quote_code": "FXQ20260605101530USDVND0001",
"last_updated": "2026-06-05 10:15:00",
"valid_until": "2026-06-05 10:16:00"
}
}

Mã lỗi

Mã ResponseThông báo Response
200Thành công
101Lỗi hệ thống
110Mã merchant không hợp lệ
120Signature không hợp lệ
404Cặp tiền tệ không được hỗ trợ
422Lỗi xác thực
423Tỷ giá FX không khả dụng
429Quá nhiều yêu cầu